SureTax Config API

POST User

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The POST User API endpoint facilitates the process of creating a new user. As part of the process, the newly created user will receive an email.

OperationId: POST User

Authorization Method(s): OAuth

Verb: POST

End Point: /api/v1/User

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
First Name *	firstName	string
Last Name *	lastName	string
Web Role *	webRole	string
Email *	email	string
Active *	active	boolean
Phone Number	phoneNumber	string
Mfa Contact	mfaContact	string
Preparer	preparer	boolean
Tax Id	taxId	string
Title	title	string
Access To All LFEs	accessToAllLFEs	boolean
Access To LFEs	accessToLFEs	array[]
Companies	companies	array[]

Example Request

The following is an json request for this operation.

{
  "firstName": "name",
  "lastName": "last name",
  "webRole": "role1",
  "email": "user1@wk.com",
  "active": true,
  "phoneNumber": "1234567890",
  "mfaContact": "user1mfa@wk.com",
  "preparer": true,
  "taxId": "1234567890",
  "title": "Preparer tittle",
  "accessToAllLFEs": true,
  "accessToLFEs": [
    "000000001",
    "000000002"
  ],
  "companies": [
    "company 1"
  ]
}

*Mandatory parameter

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
201	The API responds with this code to indicate that the data was created successfully.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/User

Add Request Headers:

{
  "firstName": "name",
  "lastName": "last name",
  "webRole": "role1",
  "email": "user1@wk.com",
  "active": true,
  "phoneNumber": "1234567890",
  "mfaContact": "user1mfa@wk.com",
  "preparer": true,
  "taxId": "1234567890",
  "title": "Preparer tittle",
  "accessToAllLFEs": true,
  "accessToLFEs": [
    "000000001",
    "000000002"
  ],
  "companies": [
    "company 1"
  ]
}